 /**
 * Copyright (c) 2008, Mu Dynamics.
 *  All rights reserved.
 *  
 *   Redistribution and use in source and binary forms, with or without modification, 
 *   are permitted provided that the following conditions are met:
 *   
 *  - Redistributions of source code must retain the above copyright notice, 
 *     this list of conditions and the following disclaimer.
 *  - Redistributions in binary form must reproduce the above copyright notice, 
 *     this list of conditions and the following disclaimer in the documentation and/or 
 *     other materials provided with the distribution.
 *  - Neither the name of the "Mu Dynamics" nor the names of its contributors may be used 
 *     to endorse  or promote products derived from this software without specific prior 
 *     written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.mu.jacob.core.model.decorator;

/**
 * General interface for decorators
 */
public abstract class DefaultDecorator<T> {

	/**
	 * Initializes decorator after construction
	 * @param model
	 */
	abstract public void initialize(T model);
	
	/**
	 * @return decorated object
	 */
	abstract public T getDecorated();
	
	/**
	 * @return the Interface class the class
	 * decorated.
	 */
	abstract public Class<T> getApiClass();
	
	@Override
	public final String toString() {
		return getDecorated().toString();
	}

	/**
	 * @see java.lang.Object#equals(java.lang.Object)
	 */
	@Override
	public final boolean equals(Object obj) {
		if (obj instanceof DefaultDecorator) {
			return getDecorated().equals(((DefaultDecorator)obj).getDecorated());
		}
		return getDecorated().equals(obj);
	}
	
	/**
	 * @see java.lang.Object#hashCode()
	 */
	@Override
	public final int hashCode() {
		return getDecorated().hashCode();
	}	
	
	/**
	 * This method is required if passing instances back to compiler.
	 * This method is required because aoialliance implementation
	 * does not support attribute alteration on method interception.
	 * @param obj
	 * @return undecorated object
	 */
	@SuppressWarnings("unchecked")
	protected <R> R undeco(final R obj) {
		if (obj instanceof DefaultDecorator) {
			return ((DefaultDecorator<R>)obj).getDecorated();
		}
		return obj;
	}
	
}
